/**
 *  Copyright 2002-2009 the original author or authors.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package foo.bar.wiki.web.action;

import org.displaytag.pagination.PaginatedList;
import org.displaytag.properties.SortOrderEnum;

import java.util.List;
import java.io.Serializable;

/**
 * An extension to DisplayTag's {@link org.displaytag.pagination.PaginatedList}.
 * <p/>
 * As far as user is concern, he needs to
 * <ul>
 *  <li>{@link #setObjectsPerPage(int)} (at least 1, else default to 10)</li>
 *  <li>{@link #setPageNumber(int)} (starts with 1, else default to first page)</li>
 * </ul>
 *
 * @see {@link ExtendedPaginatedListImpl}
 *
 * @author tmjee
 * @version $Date$ $Id$
 */
public interface ExtendedPaginatedList<T> extends PaginatedList, Serializable {

    void setList(List<T> list);
    void setPageNumber(int pageNumber);
    void setFullListSize(int fullSize);
    void setSortCriterion(String sortCriterion);
    void setSortDirection(SortOrderEnum sortDirection);
    void setObjectsPerPage(int objectsPerPage);
    int getTotalPages();
    boolean isAnyPreviousPage();
    boolean isAnyNextPage();

}
